Skip to main content
Feedback

Interactive Documentation Access Control

The Interactive Documentation Access Control (Design > APIs) page controls which developers and portal access groups can view I/O Doc items for an API definition on the Developer Portal. You can specify a role — Administrative or Portal Access Group — to grant or restrict access, and the Developer Portal shows only the I/O Doc items permitted for the user's role.

Assigning and restricting access to an I/O Doc

Specify the roles that will have access to the API definition Interactive Documentation on the Developer Portal.

Procedure

  1. Navigate to Design > Interactive Documentation. This opens the Interactive Documentation page.

  2. In the API Name column, select the API name link next to the row for which you want to control access to the Interactive Documentation. This opens the Endpoints: <your api definition name> page.

  3. Navigate to Interactive Documentation Access Control.

    1. To assign API access to a particular role or portal access group:

      • Click a role from the Unselected Roles list to grant API access. This moves the role to the Current Roles list.

        Developers assigned to this role can now test the API on the Developer Portal I/O Docs page. Refer to Managing User Access Settings for more information on assigning a role in Cloud API Management.

        info

        If a developer is not assigned a role, the Everyone role is assigned by default on the Interactive Documentation Access Control page.

    2. To restrict API access for a specific role or portal access group:

      • Click a role from the Current Roles list to remove API access. This moves the role to the Unselected Roles list.

        By restricting API access to a specific group of users or developers, you ensure that other users cannot view your API on the Developer Portal.

  4. Click Save.

Next Steps

Once access is configured, complete the following setup on the Cloud API Management (Control Center) before testing REST and GraphQL APIs on the Developer Portal:

On this Page